<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
    <title>ShellCheck: SC2025 – Make sure all escape sequences are enclosed in `\[..\]` to prevent line wrapping issues.</title>
    <link rel="stylesheet" href="css/bootstrap.min.css" />
  </head>
  <body style="margin-left: auto; margin-right: auto; max-width: 800px">
    <h1>SC2025 – ShellCheck Wiki</h1>
    <a href="https://github.com/koalaman/shellcheck/wiki/SC2025">See this page on GitHub</a>
    <p style="display: none"><a href="index.html">Sitemap</a></p>
    <hr />
    <h2
id="make-sure-all-escape-sequences-are-enclosed-in--to-prevent-line-wrapping-issues">Make
sure all escape sequences are enclosed in <code>\[..\]</code> to prevent
line wrapping issues.</h2>
<h3 id="problematic-code">Problematic code:</h3>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="SC2025.html#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="va">PS1</span><span class="op">=</span><span class="st">&#39;\e[36m\$ \e(B\e[m&#39;</span></span></code></pre></div>
<h3 id="correct-code">Correct code:</h3>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="SC2025.html#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="va">PS1</span><span class="op">=</span><span class="st">&#39;\[\e[36m\]\$ \[\e(B\e[m\]&#39;</span></span></code></pre></div>
<h3 id="rationale">Rationale:</h3>
<p>Bash is unable to determine exactly which parts of your prompt are
text and which are terminal codes. You have to help it by wrapping
invisible control codes in <code>\[..\]</code> (and ensuring that
visible characters are not wrapped in <code>\[..\]</code>).</p>
<p>Note: ShellCheck offers this as a helpful hint and not a robust
check. Don't rely on ShellCheck to verify that your prompt is
correct.</p>
<h3 id="exceptions">Exceptions</h3>
<p>None.</p>
<h3 id="related-resources">Related resources:</h3>
<ul>
<li><a href="https://mywiki.wooledge.org/BashFAQ/053">BashFaq: I have a
fancy prompt with colors, and now bash doesn't seem to know how wide my
terminal is. Lines wrap around incorrectly.</a></li>
</ul>
    <hr />
    <p style='font-size: 80%'><a href="../index.html">ShellCheck</a> is a static analysis tool for shell scripts. This page is part of its documentation.</p>
  </body>
</html>


